/**
 * @(#)BaseObject.java 26 agosto 2005 01:01 PM
 *
 * Copyright (c) 2005-2010 Psiqueware S.A. de C.V. All Rights Reserved.
 * This software is the proprietary information Psiqueware S.A. de C.V.
 * Use is subject to license terms.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * <br/>Usuario : AngelElectrico
 * <br/>Creaci&oacute;n: 26 agosto 2005 01:01 PM
 * <br/>
 * <br/>
 * <br/><t5>Cambios :</t5>
 * <br/><b>Fecha | Autor  |  Cambios</b>
 * <ul>
 * <li>26 agosto 2005 01:01 PM | <a href = "mailto:AngelElectrico@PsiqueWare.com">Angel El&eacute;ctrico</a> | Creaci&oacute;n del Objeto.</li>
 *
 * </ul>
 */

package com.psiqueware.alheli.basico;

import org.apache.commons.lang.builder.CompareToBuilder;
import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;
import org.apache.commons.lang.builder.ToStringBuilder;
import org.apache.commons.lang.builder.ToStringStyle;

import java.io.Serializable;
import java.util.Date;
import java.util.List;

/**
 * Clase Base para objetos de modelo de datos.
 * Ofrece un cascar&oacute;n para los m&eacute;todos <code>toString()</code>,
 * <code>hashCode()</code> y <code>equals()</code> de org.apache.commons.lang de Jakarta Apache. <p>
 * Adem&aacute;s de implementar un id de tipo {@link Long}.
 * <p/>
 * <a href="BaseObject.java.html"><i>Ver Fuente</i> </a> </p>
 *
 * @author <a href="mailto:AngelElectrico@PsiqueWare.com">Angel El&eacute;ctrico</a>
 * @version $Revision: 1.1 $ $Date: 2005/10/20 00:04:44 $
 * @noinspection ClassWithoutLogger
 */
public abstract class BaseObject<T> implements BaseObjectInterface<T>, Serializable
{

    /**
     * Identificador &uacute;nico de este objeto.
     *
     * @noinspection ProtectedField
     */
    protected Long m_id;

    /**
     * Fecha de alta del {@link BaseObject} en la base de datos.
     */
    protected Date m_alta;


    /**
     * Fecha de la &uacute;ltima actualizaci&oacute;n del {@link BaseObject} en la base de datos.
     */
    protected Date m_actualizacion;

    /**
     * Construye una BaseObject.
     * <p>No requiere argumentos.</p>
     */
    public BaseObject()
    {
    }

    /**
     * Devuelve el identificador &uacute;nico de este objeto.
     *
     * @return id &uacute;nico de este objeto.
     */
    public final Long getId()
    {
        return m_id;
    }

    /**
     * Establece el identificador &uacute;nico de este objeto.
     *
     * @param id &uacute;nico para este objeto.
     */
    public final void setId(Long id)
    {
        this.m_id = id;
    }

    /**
     * Devuelve la Fecha de alta del {@link BaseObject} en la base de datos.
     *
     * @return Date de alta; <code>null</code> si este objeto no la incluye en su especificaci&oacute;n.
     */
    public Date getAlta()
    {
        if (m_alta == null)
        {
            return null;
        }
        else
        {
            return new Date(m_alta.getTime());
        }
    }

    /**
     * Establece la Fecha de alta del {@link BaseObject} en la base de datos.
     *
     * @param alta Fecha de alta del {@link BaseObject} en la base de datos; <code>null</code> si es necesario.
     */
    public void setAlta(final Date alta)
    {
        if (null == alta)
        {
            this.m_alta = null;
        }
        else
        {
            this.m_alta = new Date(alta.getTime());
        }
    }

    /**
     * Devuelve la &uacute;ltima actualizaci&oacute;n del {@link BaseObject} en la base de datos.
     *
     * @return Date de alta; <code>null</code> si este objeto no la incluye en su especificaci&oacute;n.
     */
    public Date getActualizacion()
    {
        if (m_actualizacion == null)
        {
            return null;
        }
        else
        {
            return new Date(m_actualizacion.getTime());
        }

    }

    /**
     * Establece la &uacute;ltima actualizaci&oacute;n del {@link BaseObject} en la base de datos.
     *
     * @param actualizacion &uacute;ltima actualizaci&oacute;n del {@link BaseObject} en la base de datos; <code>null</code> si es necesario.
     */
    public void setActualizacion(final Date actualizacion)
    {
        if (null == actualizacion)
        {
            this.m_actualizacion = null;
        }
        else
        {
            this.m_actualizacion = new Date(actualizacion.getTime());
        }
    }

    /**
     * Compara este objeto con otro.
     *
     * @param obj a ser igualado con este.
     *
     * @return <code>true</code> si los objeto son iguales; <code>false</code> en caso contrario.
     *
     * @noinspection EqualsWhichDoesntCheckParameterClass, MethodWithMultipleReturnPoints
     */
    //@Override
    public boolean equals(Object obj)
    {
        if (obj == null) return false;
        if (null == this.getId() || null == ((BaseObjectInterface) obj).getId())
        {
            return EqualsBuilder.reflectionEquals(this, obj);
        }
        return this.getId().equals(((BaseObjectInterface) obj).getId());
    }

    /**
     * Description of the Method
     *
     * @return Description of the Return Value
     *
     * @noinspection MethodWithMultipleReturnPoints
     */
    //@Override
    public int hashCode()
    {
        if (this.getId() == null)
        {
            return HashCodeBuilder.reflectionHashCode(this);
        }
        return this.getId().hashCode();
    }


    /**
     * Realiza una comparaci&oacute;n de este objeto contra otro a fin de
     * realizar una ordenaci&oacute;n natural. De ser necesario alterar el
     * orden de objetos se factible sobrecargar este m&eacute;todo.
     *
     * @noinspection MethodWithMultipleReturnPoints
     * @see Comparable#compareTo
     */
    public int compareTo(T o)
    {
        final Long thisId = this.getId();
        final Long osId = ((BaseObjectInterface) o).getId();
        if (thisId == null || osId == null)
        {
            return CompareToBuilder.reflectionCompare(this, o);
        }
        return thisId.longValue() == osId.longValue() ? 0 : thisId > osId ? 1 : -1;
    }


    /**
     * Busca un {@link BaseObjectInterface} en una Lista de estos en base a un idBuscado
     *
     * @param idBuscado id del BaseObject que se busca.
     * @param lista     {@link List} donde se esta buscando el objeto.
     *
     * @return BaseObject del id correspondiente; <code>null</code> si no lo encuetra o alguno de los par&aacute;metros es <code>null</code>.
     */
    public static BaseObjectInterface buscaObjetoListaAnidada(final Long idBuscado, final List<? extends BaseObjectInterface> lista)
    {
        BaseObjectInterface salida = null;
        if (null != lista && null != idBuscado)
        {
            for (BaseObjectInterface o : lista)
            {
                if (idBuscado.equals(o.getId()))
                {
                    salida = o;
                    break;
                }
            }
        }
        return salida;
    }

    /**
     * Convierte este {@link BaseObject} a su representaci&oacute;n textual.
     *
     * @noinspection DuplicateStringLiteralInspection, HardCodedStringLiteral, HardcodedLineSeparator
     */
    public String toString()
    {
        return ToStringBuilder.reflectionToString(this, ToStringStyle.MULTI_LINE_STYLE);
    }
}

